/*
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { SubscriptionConsumerConfiguration } from './subscriptionConsumerConfiguration';

import { ApiKeyMode } from '../application';

export interface CreateSubscription {
  /**
   * The id of the application subscribing.
   */
  applicationId: string;
  /**
   * The id plan the application is subscribing to.
   */
  planId: string;
  /**
   * Optional custom API Key that can be given when the subscription is related to an api-key plan and custom api key support is enabled.
   */
  customApiKey?: string;
  consumerConfiguration?: SubscriptionConsumerConfiguration;
  /**
   * A list of metadata associated to this subscription.
   */
  metadata?: { [key: string]: string };
  apiKeyMode?: ApiKeyMode;
}
